home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / manage / rtxsch.exe / SCHEDULE.DOC < prev    next >
Text File  |  1989-08-29  |  13KB  |  329 lines
  1.                       IBM/PC PROGRAM SCHEDULER
  2.                             USER'S GUIDE
  3.  
  4.  
  5.                        Copyright 1986,87,88,89
  6.                      Real Time eXecutives, Inc.
  7.                            P. O. Box 160
  8.                           686 South Street
  9.                          Wrentham, MA  02093
  10.                 Tel: (508) 384-7717   Tlx: 5106014524
  11.  
  12.  
  13.  
  14.  
  15.  
  16. SCHEDULE.EXE is a ShareWare program written and distributed by:
  17.  
  18.                Real Time eXecutives, Inc.  (RTX)
  19.                   686 South St.  P.O. Box 160
  20.                     Wrentham, MA 02093  USA
  21.              Tel: (508) 384-7717   Tlx: 5106014524
  22.  
  23. Feel free to pass this program on to others.  However, please pass on the
  24. original self-extraction program, RTXSCHED.EXE, instead of the individual
  25. files.  If you find this program useful and of value, a donation of $25.00
  26. would be greatly appreciated.  To become a registered user, send $45.00. 
  27. This entitles you to receive the next version of the program free of charge,
  28. when it becomes available. 
  29.  
  30. Real Time eXecutives, Inc. disclaims all warranties whether express or
  31. implied, including implied warranties of merchantability, fitness for a
  32. particular purpose, functionality, data integrity or protection.  See
  33. documentation for further disclaimers and information.
  34.  
  35. Thanks for your support.
  36.  
  37.  
  38.  
  39.                               OVERVIEW
  40.  
  41.  
  42. This program can be used to schedule the periodic execution of programs or
  43. batch files on the IBM/PC/XT/AT/PS2 and compatibles running DOS 2.x or
  44. greater.
  45.  
  46. Even though the program is similar in function and appearance to the DOS
  47. command processor ("COMMAND.COM"), it is not a replacement for it.  Instead
  48. it sits on top of the command processor and acts more like a pre-processor.
  49.  
  50. There are some important things that must be kept in mind:
  51.  
  52.      A.   First and most important, never load software from the
  53.           scheduler that will remain resident in memory (ie.
  54.           SIDEKICK, SUPERKEY, etc.).  Loading resident software
  55.           from the scheduler can trash the DOS memory allocation
  56.           tables leaving the user with no alternative but to
  57.           reboot the computer.  Make sure that all memory
  58.           resident programs that might be needed are loaded
  59.           before execution of the scheduler.  If a memory
  60.           resident program must be loaded after the scheduler has
  61.           been run, exit the scheduler using the /EXIT command,
  62.           then load the resident software and re-execute the scheduler.
  63.  
  64.      B.   Because it would be redundant, the execution of either
  65.           COMMAND.COM or SCHEDULE.EXE from within the scheduler
  66.           is not permitted.  If the user attempts to execute
  67.           either of these programs, the scheduler will reject the
  68.           request and issue an error message.
  69.  
  70.      C.   The files and programs used by the schedule program can
  71.           either reside in the default directory or in the DOS path.
  72.  
  73.  
  74.  
  75.                       SCHEDULE TABLE DEFINITION
  76.  
  77. The ASCII text file SCHEDULE.DAT is the file that the user will create or
  78. edit to define the execution times and command lines to be executed by the
  79. scheduler program.  This file can be created or edited using any ASCII text
  80. editor (ie.  Brief, PMATE, EDLIN etc.) and can reside either in the current
  81. directory or in the DOS path.  The schedule table is built from this file on
  82. initial execution of the program scheduler or by issuing the "/REBUILD"
  83. command (see below).
  84.  
  85. There are three fields in each record (text line), separated from each other
  86. by one or more spaces.  The first field is the time of day (since midnight
  87. last night) of the first or initial execution of the command line.  The
  88. second field is the time interval between executions and the third field is
  89. the command line to be executed.
  90.  
  91. The general format is:
  92.  
  93.      START_TIME  INTERVAL  COMMAND_LINE_TO_BE_EXECUTED
  94.  
  95. Times are specified as 1 to 3 integers separated by colons, in 24 hour
  96. format.
  97.  
  98. The first integer read will be considered the hours, the second the minutes
  99. and the third the seconds.  It is not necessary to enter all three integers.
  100. For example, if the desired start time is 11 PM, the user can simple enter
  101. 23.  If the interval time was ten minutes, the user could enter 00:10.  If
  102. the start time was 1 AM plus 10 seconds the user would have to enter
  103. 1:00:10.
  104.  
  105. The hour field can be greater than 24.  For example, if the desired execution
  106. interval is every 2 days, the user would enter a 48 for the time interval.
  107.  
  108. If the execution interval time is zero, the command line will be executed
  109. once and only once at the start time specified.  If the start time is
  110. specified greater than the current time, the command line will be executed
  111. once only at that time.  If the start time is less than the current time, the
  112. command line will be executed once only at the specified start time + 24
  113. hours.  After a "run once only" command has been executed, its entry will be
  114. removed from the schedule table.  It will not be removed from the
  115. SCHEDULE.DAT file.  The command line can be re-scheduled by re-executing the
  116. schedule program or by re-building the schedule table using the "/REBUILD"
  117. command.
  118.  
  119. If the first character in a schedule definition record is anything other than
  120. an ASCII digit (0 -9), the entry will be considered a comment and ignored.
  121. This will allow for the inclusion of comments in the schedule definition
  122. file.  The exception to this rule is the reserved word "NOW".  If "NOW" is
  123. entered for a start time, the command will be executed at program load (or
  124. any time the schedule table is rebuilt).  Examples of comment entries and the
  125. "NOW" execution, can be seen below in the definition file entry examples.
  126.  
  127. If the schedule definition file is not found or is empty, the scheduler will
  128. function properly but no commands will scheduled for execution.  The user
  129. will be notified if there are no table entries.
  130.  
  131. The following are examples of entries in the schedule definition file.  Note
  132. that the command line must be <= 127 characters and each field is separated
  133. by one or more spaces.
  134.  
  135.  
  136. Example 1:
  137. * Being that the first character is not a digit, this is a comment line
  138. *
  139.  
  140.  
  141. Example 2:
  142. * Execute the program PROG1.COM every 10 minutes starting at
  143. * midnight, with command line arguments ARG1 to ARGn.
  144. *
  145. 00:00:00  00:10:00  PROG1 ARG1 ARG2 ... ARGn
  146.  
  147.  
  148. Example 3:
  149. * Execute the program PROG2.EXE every 1 hour and 1 minute starting
  150. * at 10:01:10 AM.
  151. *
  152. 10:01:10  1:01  PROG2
  153.  
  154.  
  155. Example 4:
  156. * Execute the internal SCHEDULE command /HELP once and only once
  157. * at 2:11:32 PM.
  158. *
  159. 14:11:32  00:00:00  /help
  160.  
  161.  
  162. Example 5:
  163. * Execute the DOS command DIR once and only once on load (or rebuild)
  164. *
  165. NOW  00:00:00  DIR
  166.  
  167.  
  168. Example 6:
  169. * Execute the batch file JOB.BAT with the command line arguments ARG1
  170. * to ARGn once every 2 days starting at 12 AM
  171. *
  172. 12  48  JOB arg1 arg2 ... argn
  173.  
  174.  
  175.  
  176.                          SCHEDULER LOG FILE
  177.  
  178. If the /LOG function is activated (see below) then entries will be written to
  179. the file SCHEDULE.LOG.  The log file can either be in the current directory
  180. or in the DOS path.  If it is not found, it will be created in the current
  181. directory.  The user should be aware that the log file is never deleted by
  182. the program.  If the /LOG function is used extensively the file can grow very
  183. large.  It is up to the user to delete this file when appropriate.
  184.  
  185.  
  186.  
  187.                           INTERNAL COMMANDS
  188.  
  189. This is a list of the internal commands that can be entered on the SCHEDULE
  190. command line and a brief explanation of their function :
  191.  
  192.     /EXIT        - Exit the scheduler.
  193.     /HELP or "?" - Quick reference of commands.
  194.     /LIST        - List the current schedule table.
  195.     /REBUILD     - Rebuild the schedule table.
  196.     /LOG         - Set (or report) Log mode.
  197.     /SPACE       - Set (or report) Save Space mode
  198.     /DISABLE     - Disable schedule table checking.
  199.     /ENABLE      - Enable schedule table checking.
  200.     /FLAGS       - Display current flag settings.
  201.     /NOTICE      - Display shareware notice.
  202.  
  203. On the following pages we will explain in detail the function of each of
  204. these commands:
  205.  
  206.  
  207.  
  208.    Command : /EXIT
  209.  
  210.    Function : Exit from the scheduler.
  211.  
  212.      Entering "/EXIT" on the command line will exit the scheduler
  213.      program.
  214.  
  215.  
  216.  
  217.    Command : /HELP or "?"
  218.  
  219.    Function : Display a list of internal commands.
  220.  
  221.      This command is provided so that a "quick reference" list of the
  222.      internal commands is available on line to the user without having to
  223.      refer to the manual.
  224.  
  225.  
  226.  
  227.    Command : /LIST [PR]
  228.  
  229.    Function : List the current schedule table.
  230.  
  231.      This internal command will display a list of the current schedule
  232.      table.  If a hard copy of this list is desired, the user can enter the
  233.      command followed by "PR" (ie.  "/LIST PR").  This will send the output
  234.      list to the printer instead of the screen.
  235.  
  236.  
  237.  
  238.    Command : /REBUILD
  239.  
  240.    Function : Rebuild the schedule table.
  241.  
  242.      This internal command rebuilds the schedule table on line.  If the
  243.      schedule table needs to be changed, the user can edit the schedule file
  244.      and then enter "/REBUILD".  The current schedule table will be deleted
  245.      and a new table built from the file.
  246.  
  247.  
  248.  
  249.    Command : /LOG [=level] [ON] [OFF]
  250.  
  251.    Function : Log program execution in the log file.
  252.  
  253.      This internal command will set the log level and select output to the
  254.      log file.  If the log level is set to 1 (ie.  "/LOG=1") only the
  255.      scheduled executions will be logged.  If the log level is set to 2 or
  256.      greater, both the scheduled executions and the manual executions (user
  257.      typed command lines) will logged.  When a program execution is logged,
  258.      the time and date stamp, the execution request type ("MANUAL" or
  259.      "SCHEDULED"), and the command line will be written to the log file.  The
  260.      keyword OFF turns logging off.  The key word ON restores logging to the
  261.      level that it was set to before an OFF was issued.
  262.  
  263.  
  264.  
  265.    Command : /SPACE [ON] [OFF]
  266.  
  267.    Function : Set Save Space mode (or report current setting).
  268.  
  269.      This internal command will set the Save Space mode "ON" or "OFF".  If
  270.      the selected Save Space mode is "ON" the program will try to execute
  271.      commands as child processes before passing the command to the DOS
  272.      command handler.  This will save space as the command handler does not
  273.      always have to be loaded into memory.  The default mode is "OFF".
  274.  
  275.      <<WARNING>> If the selected Save Space mode is "ON", you can NOT
  276.      redirect or pipe the output of a program.  Mode "ON" should be selected
  277.      only if you have problems with not enough memory.
  278.  
  279.  
  280.  
  281.    Command : /DISABLE
  282.  
  283.    Function : Disables schedule table checking.
  284.  
  285.      In the normal operation of the scheduler, the program will check to see
  286.      if there is a scheduled program to execute and then check to see if you
  287.      are pressing keys on the keyboard.  If you are pressing keys, the
  288.      program will temporarily suspend the schedule table check, allowing you
  289.      to enter the entire command without interrupting you.  There is however
  290.      a 10 second timeout on key hits.  That is, if you wait more than 10
  291.      seconds, the program will go off and check again for a scheduled
  292.      program.  If you're like me, you may sometimes spend more than 10
  293.      seconds thinking before pressing another key, or maybe you want to write
  294.      down something that is displayed on the screen.  This internal command
  295.      forces the program to stop all schedule table checking, allowing you as
  296.      much time as you need.  A warning will be displayed with each prompt if
  297.      checking is disabled.
  298.  
  299.      ** Remember ** if you disable schedule table checking, you must re-
  300.      enable it or none of the scheduled programs will get executed.
  301.  
  302.  
  303.  
  304.    Command : /ENABLE
  305.  
  306.    Function : Enable schedule table checking after it has been
  307.               disabled.
  308.  
  309.      This internal command allows you to start up the schedule table checking
  310.      again, after it has been disabled.
  311.  
  312.  
  313.  
  314.    Command : /FLAGS
  315.  
  316.    Function : Display current flag settings.
  317.  
  318.      This internal command will display a list of the current flag settings.
  319.      These flags include:  Schedule checking, Save space, Debug, and Logging
  320.      mode.
  321.  
  322.  
  323.  
  324.    Command : /NOTICE
  325.  
  326.    Function : Display shareware notice.
  327.  
  328.      This internal command will display the shareware notice.
  329.